/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.calcite.rel.mutable;

import org.apache.calcite.rel.core.TableScan;

/** Mutable equivalent of {@link org.apache.calcite.rel.core.TableScan}. */
public class MutableScan extends MutableLeafRel {
  private MutableScan(TableScan rel) {
    super(MutableRelType.TABLE_SCAN, rel);
  }

  /**
   * Creates a MutableScan.
   *
   * @param scan  The underlying TableScan object
   */
  public static MutableScan of(TableScan scan) {
    return new MutableScan(scan);
  }

  @Override public boolean equals(Object obj) {
    return obj == this
        || obj instanceof MutableScan
        && rel.getTable().getQualifiedName().equals(((MutableScan) obj).rel
            .getTable().getQualifiedName());
  }

  @Override public int hashCode() {
    return rel.getTable().getQualifiedName().hashCode();
  }

  @Override public StringBuilder digest(StringBuilder buf) {
    return buf.append("Scan(table: ")
        .append(rel.getTable().getQualifiedName()).append(")");
  }

  @Override public MutableRel clone() {
    return MutableScan.of((TableScan) rel);
  }
}
